Skip to content

[v7r2] scriptdocs#4958

Merged
atsareg merged 21 commits into
DIRACGrid:integrationfrom
TaykYoku:v7r2_scriptdocs
Feb 15, 2021
Merged

[v7r2] scriptdocs#4958
atsareg merged 21 commits into
DIRACGrid:integrationfrom
TaykYoku:v7r2_scriptdocs

Conversation

@TaykYoku

@TaykYoku TaykYoku commented Feb 9, 2021

Copy link
Copy Markdown
Contributor

This PR provide some #4853 and #4954 changes.
Much of the description of scripts from CommandReference *.rst's are transferred to the __doc__'s of a script files.

The main change in LocalConfiguration.py and Script files, other changes concern the design of script docs mainly.

BEGINRELEASENOTES

*All systems affected:
CHANGE: use __doc__ for script help message, remove filecfg as argument from usage description

*Core:
CHANGE: when import Script, a help message is formed from __doc__, not need to use Script.setUsageMessage(__doc__)

*Configuration:
CHANGE: setUsageMessage in LocalConfiguration will parse received str value for building help message

ENDRELEASENOTES

@fstagni

fstagni commented Feb 10, 2021

Copy link
Copy Markdown
Contributor

This looks fine to me, with just a small caveat: for the dirac-version and dirac-platfom script can you align to what I have done in #4954 ? To avoid possible conflicts.

Comment thread src/DIRAC/ConfigurationSystem/Client/LocalConfiguration.py Outdated
Comment thread src/DIRAC/ProductionSystem/scripts/dirac_prod_delete.py Outdated
@atsareg atsareg merged commit 689caaa into DIRACGrid:integration Feb 15, 2021
@TaykYoku TaykYoku deleted the v7r2_scriptdocs branch February 15, 2021 19:55
@chrisburr chrisburr mentioned this pull request Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants